home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 / Ham Radio 2000.iso / ham2000 / morse / xtapls01 / readme.1st < prev    next >
Text File  |  1996-05-04  |  18KB  |  502 lines
  1. XTAPLS01.ZIP: EXTRAPLUS VERSION 1, Dated 4 V 96
  2.  
  3.            "EXTRAPLUS: CW beyond 20 WPM"
  4.  
  5.  
  6. I. INTRODUCTION
  7.  
  8.  
  9. EXTRAPLUS is intended primarily for amateurs who have 
  10. passed all the code exams and want to improve their CW 
  11. operating skills. The executable and text files in EXTRAPLUS 
  12. are used to create files for input to code training software 
  13. similar to GGTE's Morse Tutor Gold (MTG). For those who lack 
  14. this type of software, a very unsophisticated program has been 
  15. provided to transmit these files through the computer speaker. 
  16. Amateurs who have not reached the 20 WPM level and have access 
  17. to MTG-like software will find EXTRAPLUS a useful tool in their
  18. efforts to upgrade. EXTRAPLUS is Freeware by Art Sadler, KC7IG.
  19.  
  20. The types of files which may be created are:
  21.  
  22.    - "fixed" text. Conventional text files like the one you
  23.      are reading are converted to files more suitable for use
  24.      with code training software. These are especially useful
  25.      for improving sending skills; just "play" them and key or
  26.      type along in step.
  27.  
  28.    - random character groups. The length of the groups are
  29.      random within limits set by the user. Optionally, the user
  30.      may specify characters that are to appear more frequently
  31.      than others.
  32.  
  33.    - QSO words. The real enjoyment of Morse begins with the 
  34.      ability to copy without writing down every character heard.
  35.      The most common words are included.
  36.  
  37.    - calls. Life is hard. Either copy the call correctly or it's 
  38.      no QSO! The user can create files of calls extracted
  39.      automatically from files which contain calls intermixed
  40.      with other text. Other programs scramble calls, or QSO 
  41.      words, in a file to prevent the user from memorizing their 
  42.      order. 
  43.  
  44.    - pseudo-calls. These are random character groups that 
  45.      conform to the formats of calls. Don't even think about
  46.      trying these unless conventional calls become boring.
  47.      Pseudo-calls have been known to humble the mighty.
  48.  
  49. Earlier I mentioned a simple program to transmit text files as 
  50. Morse through the computer speaker. It is named BB, as in
  51. beep-beep. This program allows the user to specify the tone 
  52. frequency in Hertz and speed in terms of dit duration. The longer 
  53. the dit, the slower the speed. Recognition of prosign substitution 
  54. characters has been implemented with the protocols used in GGTE's 
  55. Morse Tutor Gold: AR is "+", SK is "[", BT is "=", and KN is "(". 
  56. Farnsworth timing is not supported. Using BB to prepare for 
  57. taking or administering a code exam would be a very bad idea. The 
  58. code produced just isn't good enough for those purposes. BB, and 
  59. its cousin BB2, were written one evening when I had nothing better 
  60. to do. They are included here to permit the user to experience 
  61. the benefits of computer-aided code practice. Investing in a 
  62. quality commercial or shareware product is well worth the expense. 
  63. Having taken the trouble to code a Morse engine, it was impossible 
  64. to overcome the temptation to put it to other uses. The code 
  65. practice game CALLGAME is the result. 
  66.  
  67. The second section of this README.1ST file is devoted to an 
  68. alphabetized list of all the files in XTAPLS01.ZIP. The 
  69. syntax of the command lines is self-explanatory in most 
  70. cases; examples have been included for the more complex 
  71. ones. Command line arguments are positional and mandatory. 
  72. Failure to provide the necessary arguments will result in a
  73. series of prompts to request the needed information. File 
  74. names are assumed to be in the current directory unless a 
  75. path is specified. CWTXTFIX.EXE, CWTXTFX2.EXE, the GEN*.EXE 
  76. series, and the *SCRAM*.EXE series prepare files that will be 
  77. used as input to the Morse software. The other utilities 
  78. provide the means of creating resources that can be used by 
  79. the programs named above. Also included are files of calls
  80. (SUMCALLS.LCL) and words used in QSOs (QSOWORDS.LWD) to get
  81. you started.
  82.  
  83. It will be found that the easiest way to put EXTRAPLUS to
  84. work, once you're familiar with the utilities, is to use
  85. .BAT files. An example, MAKCALLS.BAT, is included. BAT file
  86. gurus will be happy to learn that all EXTRAPLUS programs
  87. provide return codes for branching purposes.
  88.  
  89. The programs were written in the C language and compiled
  90. using Borland C++ Version 2.0. The design goal was to write
  91. programs to run under DOS on any computer that accommodates
  92. the target Morse software. Some Morse software packages
  93. perform better if characters come from the file in a stream
  94. without CR-LF characters, i.e., 0D 0A hexadecimal. Other
  95. packages demand a CR-LF after each "line" and become
  96. confused and unhappy if they aren't detected. Both modes are
  97. supported by EXTRAPLUS.
  98.  
  99. To keep things straight, I use the following extensions to
  100. classify the various type of text files. In these
  101. definitions, the word "scrambled" means a set or subset of
  102. items from another file in a random order.
  103.  
  104. .TXT - a text file of unknown characteristics.
  105. .LCL - "line" calls or pseudo-calls separated by CR-LFs. See
  106.          SUMCALLS.LCL for an example.
  107. .LWD - "line" words or random groups separated by CR-LFs.
  108.          See QSOWORDS.LWD for an example.
  109. .CAL - calls or pseudo-calls separated by spaces.
  110. .WRD - words or random groups separated by spaces.
  111. .SLC - scrambled "line" calls or pseudo-calls.
  112. .SLW - scrambled "line" words or random groups.
  113. .SSC - scrambled calls or pseudo-calls separated by spaces.
  114. .SSW - scrambled words or random groups separated by spaces.
  115. .FTX - a "fixed" .TXT file produced by CWTXTFIX.EXE which
  116.          contains no CR-LFs.
  117. .FX2 - a "fixed" .TXT file produced by CWTXTFX2.EXE which
  118.          does contain CR-LFs.
  119.  
  120. The use of these extensions is not enforced by the 
  121. utilities. You may use any system you desire or no system at 
  122. all. These extensions will, however, be used in the utility 
  123. descriptions in the next section of this README.1ST.
  124.  
  125. Let me offer a suggestion on finding a ready source of calls 
  126. when you've grown tired of those in SUMCALLS.LCL. If you 
  127. browse the Amateur Radio pages and FTP sites on the 
  128. Internet, you will find plenty of text to copy and files to 
  129. download that contain calls. The utility GETCALLS.EXE reads 
  130. .TXT files and creates a .LCL file of the calls it finds. 
  131. If that source runs dry, you can use GENPCALS.EXE to create 
  132. pseudo-calls. I seldom run this utility without generating at 
  133. least one call that is currently assigned. Some day I expect 
  134. to see my own!
  135.  
  136.  
  137. II. FILE DESCRIPTIONS
  138.  
  139.  
  140. ******    BB    ******    BB    ******    BB    ******
  141.  
  142. BB.EXE: a program that reads a text file and sends Morse 
  143. code through the speaker. Depressing Esc ends execution.
  144.  
  145. The syntax is:
  146.  
  147.  [path]bb [path]input_file
  148.  
  149. BB returns a code of 1 if the input file can not be read;   
  150. otherwise the return code is 0. GGTE conventions are used 
  151. for the prosigns.
  152.  
  153.  
  154. ******    BB2    ******   BB2   ******    BB2    ******
  155.  
  156. BB2.EXE: a program that reads a text file and sends Morse 
  157. code through the speaker. Depressing Esc ends execution.
  158.  
  159. The syntax is:
  160.  
  161.  [path]bb2 [path]input_file
  162.  
  163. BB2 returns a code of 1 if the input file can not be read;   
  164. otherwise the return code is 0. BB2 is identical to BB   
  165. except that the entire file (max. 3K chars.) is read into   
  166. RAM before code transmission begins. The intent is that   
  167. this will eliminate pauses that occur when a physical disk  
  168. read takes place. The size of input_file and your hardware 
  169. will determine whether BB2 has any advantage over BB. 
  170.  
  171.  
  172. ****** CALLGAME ****** CALLGAME ****** CALLGAME ******   
  173.  
  174. CALLGAME.EXE: a program that allows the user to assume the 
  175. role of DXpedition operator. A second user is required to
  176. run the keyboard while "the Op" runs the pileup! A .LCL file 
  177. is the source of the pileup calls. See CGHOWTO.TXT for 
  178. details.
  179.  
  180. The syntax is:
  181.  
  182.  [path]callgame [path]call_file
  183.  
  184. A non-zero return code indicate the input file could not be 
  185. opened (code 1), or an error occurred during read of the 
  186. input file (code 2).
  187.  
  188.  
  189. ******  CGHOWTO ****** CGHOWTO ******  CGHOWTO  ******
  190.  
  191. CGHOWTO.TXT: how to play CALLGAME
  192.  
  193.  
  194. ****** CWTXTFIX ****** CWTXTFIX ****** CWTXTFIX ******
  195.  
  196. CWTXTFIX.EXE: a program to filter a .TXT file for use with 
  197. CW practice software. The output, a .FTX file, will be free 
  198. of most of the garbage that makes the typical text file 
  199. (like the one you're reading) unsuitable for use as input to 
  200. Morse software. For optimum results, use a text editor to 
  201. remove any tables of contents, indexes, charts, and diagrams 
  202. present in the text file before invoking CWTXTFIX. See also
  203. CWTXTFX2.
  204.  
  205. The syntax is:
  206.  
  207.  [path]cwtxtfix [path]input_file [path]output_file
  208.  
  209. Non-zero return codes indicate a problem opening the read 
  210. (code 1) or write (code 2) file, an error during read
  211. (code 3), or during write (code 4).
  212.  
  213.  
  214. ****** CWTXTFX2 ****** CWTXTFX2 ****** CWTXTFX2 ******
  215.  
  216. CWTXTFX2.EXE: a program identical to CWTXTFIX except that it
  217. creates .FX2 files for Morse software that requires the CR-LF
  218. pair at the end of each line.
  219.  
  220. The syntax is:
  221.  
  222.  [path]cwtxtfx2 [path]input_file [path]output_file
  223.  
  224. Non-zero return codes indicate a problem opening the read 
  225. (code 1) or write (code 2) file, an error during read
  226. (code 3), or during write (code 4).
  227.  
  228.  
  229. ****** GENPCALS ****** GENPCALS ****** GENPCALS ******
  230.  
  231. GENPCALS.EXE: a program to generate a .CAL file of pseudo-
  232. calls. The user specifies the number of spaces to follow 
  233. each call.
  234.  
  235. The syntax is:
  236.  
  237.  [path]genpcals  [path]output_file  nbr_of_calls
  238.   nbr_of_trailing_spaces.
  239.  
  240. Non-zero return codes indicate a problem opening the write 
  241. file(code 1) or an error during write (code 2).
  242.  
  243. Example:
  244.  
  245. To create the file OUT.CAL containing 200 pseudo-calls with 
  246. 2 trailing spaces, enter:
  247.  
  248.  genpcals out.cal 200 2
  249.  
  250.  
  251. ****** GENRRGPS ****** GENRRGPS ****** GENRRGPS ******
  252.  
  253. GENRRGPS.EXE: a program to generate a .WRD file of random 
  254. length, random character groups. Each group will be followed 
  255. by a single space.
  256.  
  257. The syntax is:
  258.  
  259.  [path]genrrgps   [path]output_file   nbr_of_groups
  260.  min_nbr_of_chars_per_grp   max_nbr_chars_per_grp
  261.  
  262. Non-zero return codes indicate a problem opening the write 
  263. file (code 1) or an error during write (code 2).
  264.  
  265. Example:
  266.  
  267.  To create the file OUT.WRD containing 100 random groups 
  268. varying in size from 4 to 7 characters, enter:
  269.  
  270.  genrrgps out.wrd 100 4 7
  271.  
  272.  
  273. ****** GENSPGPS ****** GENSPGPS ****** GENSPGPS ******
  274.  
  275. GENSPGPS.EXE: a program to generate a .WRD file of random 
  276. length, random character groups. The user specifies a list 
  277. of up to 20 characters to appear more frequently than a true 
  278. random selection would provide. Each group is followed by a 
  279. single space.
  280.  
  281. The syntax is:
  282.  
  283.  [path]genspgps   [path]output_file   nbr_of_groups
  284.  min_nbr_of_chars_per_grp    max_nbr_chars_per_grp 
  285.  char_list
  286.  
  287. Non-zero return codes indicate a problem opening the write 
  288. file (code 1) or an error during write (code 2).
  289.  
  290. Example:
  291.  
  292. To create the file OUT.WRD containing 150 random groups 
  293. varying in length from 3 to 8 characters with S, H, 5, 6, 
  294. and B predominating, enter:
  295.  
  296.  genspgps out.lwd 150 3 8 sh56b
  297.  
  298.  
  299. ****** GETCALLS ****** GETCALLS ****** GETCALLS ******
  300.  
  301. GETCALLS.EXE: a program to extract any calls or pseudo-calls 
  302. present in a file and write them to a .LCL or .CAL file. If 
  303. the user specifies zero as the number of spaces to follow 
  304. each call, a .LCL file will be produced containing no 
  305. trailing spaces.
  306.  
  307. The syntax is:
  308.  
  309.  [path]getcalls  [path]input_file  [path]output_file
  310.   nbr_spaces_after_each_call
  311.  
  312. Non-zero return codes indicate a problem opening the read 
  313. (code 1) or write (code 2) file, an error during read
  314. (code 3), or during write (code 4).
  315.  
  316.  
  317. ******  LINECNT  ****** LINECNT ******  LINECNT  ******
  318.  
  319. LINECNT.EXE: a program to count the lines in a file, display 
  320. the longest and shortest lines, and compute the average line 
  321. length.
  322.  
  323. The syntax is:
  324.  
  325.  [path]linecnt  [path]input_file
  326.  
  327. Non-zero indicate the following conditions: 1 = couldn't 
  328. open file; 2 = error while reading file.
  329.  
  330.  
  331. ******  LSCRAM  ******  LSCRAM  ******  LSCRAM  ******
  332.  
  333. LSCRAM.EXE: a program that reads a .LCL or .LWD file and 
  334. writes up to 300 lines out to a .SLC or .SLW file in random 
  335. order. Each line read may contain up to 20 characters. 
  336. Duplicate output lines may occur.
  337.  
  338. The syntax is:
  339.  
  340.  [path]lscram [path]input_file  [path]output_file
  341.  
  342. Non-zero return code indicate the input (code 1) or output 
  343. (code 2) file could not be opened, or an error occurred 
  344. during read of the input file (code 3).
  345.  
  346.  
  347. ****** LSCRAMND ****** LSCRAMND ****** LSCRAMND ******
  348.  
  349. LSCRAMND.EXE: a program that reads a .LCL or .LWD file and 
  350. writes up to 300 lines out to a .SLC or .SLW file in a non-
  351. repeating, random order. Each line read may contain up to 20
  352. characters.
  353.  
  354. The syntax is:
  355.  
  356.  [path]lscramnd [path]input_file  [path]output_file
  357.  
  358. Non-zero return code indicate the input (code 1) or output 
  359. (code 2) file could not be opened, or an error occurred 
  360. during read of the input file (code 3).
  361.  
  362.  
  363. ****** MAKCALLS ****** MAKCALLS ****** MAKCALLS ******
  364.  
  365. MAKCALLS.BAT: a sample .BAT to illustrate how to use 
  366. EXTRAPLUS programs in combination. For additional ideas, 
  367. see Figure 1 at the end of this Section.
  368.  
  369.  
  370. ******  NODUPS  ******  NODUPS  ******  NODUPS  ******
  371.  
  372. NODUPS.EXE: a program that reads a sorted .LCL or .LWD file,  
  373. eliminates blank or duplicate lines, and writes the 
  374. remaining lines to a .LCL or .LWD file. An activity summary 
  375. is displayed on the screen at the end of the operation.
  376.  
  377. The syntax is:
  378.  
  379.  [path]nodups [path]input_file  [path]output_file
  380.  
  381. Non-zero return codes indicate the input (code 1) or output 
  382. (code 2) file could not be opened, or an error occurred 
  383. during read of the input file (code 3).
  384.  
  385.  
  386. ****** QSOWORDS ****** QSOWORDS ****** QSOWORDS ******
  387.  
  388. QSOWORDS.LWD:  a starter set of 200-odd words often heard in 
  389. QSOs. Add or delete words as you wish. Words are in 
  390. alphabetical order only to make maintenance easier.
  391.  
  392.  
  393. ******  README  ******  README  ******  README  ******
  394.  
  395. README.1ST:  this file
  396.  
  397.  
  398. ******  SPC2LN  ******  SPC2LN  ******  SPC2LN  ******
  399.  
  400. SPC2LN.EXE: a program to read a .CAL or .WRD file and write  
  401. its contents to a .LCL or .LWD file. Trailing spaces in the 
  402. input file do not appear in the output file. The primary
  403. purpose of this program is the conversion of files built
  404. by the GEN*.EXE series to make them usable with Morse 
  405. software that demands CR-LF pairs.
  406.  
  407. The syntax is:
  408.  
  409.  [path]spc2ln [path]input_file [path]output_file
  410.  
  411. Non-zero return codes indicate a problem opening the read 
  412. (code 1) or write (code 2) file, an error during read
  413. (code 3), or during write (code 4).
  414.  
  415.  
  416. ******  SSCRAM  ******  SSCRAM  ******  SSCRAM  ******
  417.  
  418. SSCRAM.EXE: a program that reads a .LCL or .LWD file  and 
  419. writes up to 300 lines out to a .SSC or .SSW file in random 
  420. order with one or more trailing spaces. Each line read may 
  421. consist of up to 20 characters. Duplicates may occur in the 
  422. output file.
  423.  
  424. The syntax is:
  425.  
  426.  [path]sscram [path]input_file [path]output_file 
  427.   nbr_spaces
  428.  
  429. Non-zero return codes indicate the input (code 1) or output 
  430. (code 2) file could not be opened, or an error occurred 
  431. during read of the input file (code 3).
  432.  
  433.  
  434. ****** SSCRAMND ****** SSCRAMND ****** SSCRAMND ******
  435.  
  436. SSCRAMND.EXE: a program that reads a .LCL or .LWD file and 
  437. writes up to 300 lines out to a .SSC or .SSW file in a non-
  438. repeating, random order with one or more trailing spaces. 
  439. Each line read may consist of up to 20 characters.
  440.  
  441. The syntax is:
  442.  
  443.  [path]sscramnd [path]input_file  [path]output_file
  444.  nbr_spaces
  445.  
  446. Non-zero return codes indicate the input (code 1) or output 
  447. (code 2) file could not be opened, or an error occurred 
  448. during read of the input file (code 3).
  449.  
  450.  
  451. ****** SUMCALLS ****** SUMCALLS ****** SUMCALLS ******
  452.  
  453. SUMCALLS.LCL: a starter set of 500-odd calls for 
  454. CALLGAME.EXE. Add or delete calls as you wish.
  455.  
  456.  
  457. *****************************************************************************                                            
  458.                         
  459. RAW TEXT (README FILES, ETC>)--->CWTXTFIX / CWTXTFX2--->MORSE S/W (1)
  460.                         
  461.                            |->LSCRAM---|
  462. GETCALLS-->DOS SORT (2)-->NODUPS-->TEXT EDIT (3)-->|->LSCRAMND-|-->MORSE S/W
  463.              QSOWORDS.LWD / SUMCALLS.LCL-->|->SSCRAM---|
  464.                            |->SSCRAMND-|
  465.  
  466. GENPCALS->|                 
  467. GENRRGPS->|--->SPC2LN (4)--->MORSE S/W
  468. GENSPGPS->|                 
  469.                 
  470.  
  471. (1) A Morse software program that accepts file input.
  472. (2) The DOS SORT command: sort < input_file_name > output_file name
  473. (3) Cut and paste by a text editor to create a new file containing a
  474.     subset of data items from a larger file.
  475. (4) Necessary only if a "line" file is required.
  476.  
  477.             Figure 1: Typical EXTRAPLUS Usage  
  478.  
  479. *****************************************************************************
  480.  
  481.  
  482. III. COMMENTS, PROBLEMS, AND SUGGESTIONS.
  483.  
  484.  
  485. Please don't hesitate to share your ideas on EXTRAPLUS with 
  486. me. Suggestions will be given careful consideration. If you 
  487. have a problem to report, please be as specific as possible. 
  488. Some information about the computer, DOS version, and Morse 
  489. software you are using would be helpful. Please include the 
  490. full name of the compressed file in which you received 
  491. EXTRAPLUS; otherwise I may not be able to assist you. An SASE 
  492. or valid IRC is requested if you require a response. You may 
  493. copy and distribute EXTRAPLUS freely. All I ask is that you 
  494. keep all the files together, preferably in the compressed 
  495. file XTAPLS01.ZIP. 
  496.  
  497. 73 ES GL,
  498.  
  499. Art Sadler, KC7IG
  500. 2721 West Acoma Drive
  501. Phoenix, AZ 85023-5809 USA
  502.